fullfilment-ux

(0 reviews)

POST-TMF702 resourceAttributeValueChangeEvent

This operation is to submit the Subscription Transfer Status back to SES for Primary Devices

URL

https://[host]:[port]/fullfilment-ux/tmf-api/resourceActivationAndConfiguration/v4/{businessId}/resourceAttributeValueChangeEvent

url Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR, CR, CW etc.) identifying the business unit.	Y

name	value	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

cURL request - for LCR

curl --location 'https://nonprod.lcr.esb.cloud.lla.com/test/fullfilment-ux-lcr/tmf-api/resourceActivationAndConfiguration/v4/CR/resourceAttributeValueChangeEvent' \
--header 'client_id: xxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'client_secret: xxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'Content-Type: application/json' \
--data '{
    "eventId": "updatePrimaryEsimSubscriptionTransferStatus",
    "correlationId": "{{$guid}}",
    "eventType": "ResourceAttributeValueChangeEvent",
    "event": {
    "eventId": "updatePrimaryEsimSubscriptionTransferStatus",
    "correlationId": "{{$guid}}",
    "eventType": "ResourceAttributeValueChangeEvent",
    "event": {
        "resource": {
            "id": "50661430059",
            "name": "MSISDN",
            "href": "/tmf-api/resourceActivationAndConfiguration/v4/CR/resourceAttributeValueChangeEvent/50661430059",
            "resourceRelationship": [
                {
                    "relationshipType": "current profile",
                    "resource": {
                        "id": "712040001097616",
                        "name": "imsi",
                        "href": "/tmf-api/resourceActivationAndConfiguration/v4/CR/resourceAttributeValueChangeEvent/50661430059",
                        "resourceCharacteristic": [
                            {
                                "name": "iccidProfile",
                                "valueType": "object",
                                "value": {
                                    "iccid": "356935435417269",
                                    "iccidStatus": "Installed"
                                }
                            }
                        ]
                    }
                },
                {
                    "relationshipType": "new profile",
                    "resource": {
                        "id": "460019871234299",
                        "name": "imsi",
                        "href": "/tmf-api/resourceActivationAndConfiguration/v4/CR/resourceAttributeValueChangeEvent/50661430059",
                        "resourceCharacteristic": [
                            {
                                "name": "primaryMsisdn",
                                "valueType": "string",
                                "value": "50661430059"
                            },
                            {
                                "name": "subscriptionStatus",
                                "valueType": "string",
                                "value": "Active"
                            },
                            {
                                "name": "iccidProfile",
                                "valueType": "object",
                                "value": {
                                    "iccid": "35693543541770",
                                    "iccidStatus": "Installed"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}'

cURL request - for DC markets (BO,CW,SA,SE,SX,MF)

curl --location 'https://nonprod.lc.esb.cloud.lla.com/test/fullfilment-ux-lc/tmf-api/resourceActivationAndConfiguration/v4/CW/resourceAttributeValueChangeEvent' \
--header 'client_id: xxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'client_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxC' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'Content-Type: application/json' \
--data '{
    "eventId": "updatePrimaryEsimSubscriptionTransferStatus",
    "correlationId": "{{$guid}}",
    "eventType": "ResourceAttributeValueChangeEvent",
    "event": {
        "resource": {
            "id": "59991002734",
            "name": "MSISDN",
            "href": "/tmf-api/resourceActivationAndConfiguration/v4/CW/resourceAttributeValueChangeEvent/59991002734",
            "resourceRelationship": [
                {
                    "relationshipType": "current profile",
                    "resource": {
                        "id": "712040001097616",
                        "name": "imsi",
                        "href": "/tmf-api/resourceActivationAndConfiguration/v4/CW/resourceAttributeValueChangeEvent/59991002734",
                        "resourceCharacteristic": [
                            {
                                "name": "iccidProfile",
                                "valueType": "object",
                                "value": {
                                    "iccid": "356935435417269",
                                    "iccidStatus": "Installed"
                                }
                            }
                        ]
                    }
                },
                {
                    "relationshipType": "new profile",
                    "resource": {
                        "id": "460019871234299",
                        "name": "imsi",
                        "href": "/tmf-api/resourceActivationAndConfiguration/v4/CW/resourceAttributeValueChangeEvent/59991002734",
                        "resourceCharacteristic": [
                            {
                                "name": "primaryMsisdn",
                                "valueType": "string",
                                "value": "59991002734"
                            },
                            {
                                "name": "subscriptionStatus",
                                "valueType": "string",
                                "value": "Active"
                            },
                            {
                                "name": "iccidProfile",
                                "valueType": "object",
                                "value": {
                                    "iccid": "35693543541770",
                                    "iccidStatus": "Installed"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}'

cURL request - for BTC market

curl --location 'https://nonprod.lc.esb.cloud.lla.com/test/fullfilment-ux-lc/tmf-api/resourceActivationAndConfiguration/v4/BS/resourceAttributeValueChangeEvent' \
--header 'client_id: xxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'client_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxC' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'Content-Type: application/json' \
--data '{
    "eventId": "updatePrimaryEsimSubscriptionTransferStatus",
    "correlationId": "{{$guid}}",
    "eventType": "ResourceAttributeValueChangeEvent",
    "event": {
        "resource": {
            "id": "2424245599",
            "name": "MSISDN",
            "href": "/tmf-api/resourceActivationAndConfiguration/v4/BS/resourceAttributeValueChangeEvent/2424245599",
            "resourceRelationship": [
                {
                    "relationshipType": "current profile",
                    "resource": {
                        "id": "712040001097616",
                        "name": "imsi",
                        "href": "/tmf-api/resourceActivationAndConfiguration/v4/BS/resourceAttributeValueChangeEvent/2424245599",
                        "resourceCharacteristic": [
                            {
                                "name": "iccidProfile",
                                "valueType": "object",
                                "value": {
                                    "iccid": "356935435417269",
                                    "iccidStatus": "Installed"
                                }
                            }
                        ]
                    }
                },
                {
                    "relationshipType": "new profile",
                    "resource": {
                        "id": "460019871234299",
                        "name": "imsi",
                        "href": "/tmf-api/resourceActivationAndConfiguration/v4/BS/resourceAttributeValueChangeEvent/2424245599",
                        "resourceCharacteristic": [
                            {
                                "name": "primaryMsisdn",
                                "valueType": "string",
                                "value": "2424245599"
                            },
                            {
                                "name": "subscriptionStatus",
                                "valueType": "string",
                                "value": "Active"
                            },
                            {
                                "name": "iccidProfile",
                                "valueType": "object",
                                "value": {
                                    "iccid": "35693543541770",
                                    "iccidStatus": "Installed"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}'

Notes

MSISDN must always be provided in full international format including the country code to SES.
The correlationId provided in both the request header and the request body must always be unique.

Success Response - for LCR, DC markets (BO,CW,SA,SE,SX,MF), BTC

200- ok

{
  "id": "8613912344719",
  "callback": "/esimservice/v1.0/updatePrimaryEsimSubscriptionTransferStatus"
}

Definitions

Each of the request parameters is detailed.

Name	Type	Description	Required
eventId	string	name of event value: "updatePrimaryEsimSubscriptionTransferStatus"	Y
correlationId	string	unique id of correlation	N
eventType	string	type of event value: "ResourceAttributeValueChangeEvent"	Y
event	object	event object	Y
resource	object	event resource object	Y
event.resource.id	string	value of resource Example: value of MSISDN	Y
event.resource.name	string	name of the resource Value: "MSISDN"	Y
event.resource.href	string	the URI of the object	Y*
event.resource.resourceRelationship	array object	resource relationship of event resource	Y
event.resource.resourceRelationship.relationshipType	string	type of resource relationship Value: "current profile" or "new profile"	Y
event.resource.resourceRelationship.resource	object	resource of resource relationship	Y
event.resource.resourceRelationship.resource.id	string	resource identifier Example: value of imsi	Y
event.resource.resourceRelationship.resource.name	string	name of resource identifier Value: "imsi"	Y
event.resource.resourceRelationship.resource.href	string	the URI of the object	Y*
event.resource.resourceRelationship.resource.resourceCharacteristic	array object	resource characteristic	Y
event.resource.resourceRelationship.resource.resourceCharacteristic.name	string	name of resource characteristic Example: "operatorId" or "subscriptionStatus" or "iccidProfile"	Y*
event.resource.resourceRelationship.resource.resourceCharacteristic.valueType	string	value type of resource characteristic Example: "String" or "Object"	N
event.resource.resourceRelationship.resource.resourceCharacteristic.value	string/object	value of resource characteristic	N
event.resource.resourceRelationship.resource.resourceCharacteristic.value.imei	string	Value of imei	Y
event.resource.resourceRelationship.resource.resourceCharacteristic.value.iccid	string	value of iccid	Y
event.resource.resourceRelationship.resource.resourceCharacteristic.value.meid	string	value of meid	N
event.resource.resourceRelationship.resource.resourceCharacteristic.value.iccidStatus	string	value of iccidStatus	N
event.resource.resourceRelationship.resource.resourceCharacteristic.value.state	string	value of state	N

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400 ,
      "message" : "UPDATE_ESIMSUBSCRIPTION",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }
  ]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401 ,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }
  ]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{

      "code" : 404,
       "message" : "The server could not find the requested resource.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }
  ]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "METHOD_NOT_ALLOWED",
             "description": "HTTP Method xxx not allowed for : /{businessId}/resourceAttributeValueChangeEvent"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": "The request failed due to an internal error."
    }
  ]
}